/*
 *  Copyright 2012 yura.
 * 
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 * 
 *       http://www.apache.org/licenses/LICENSE-2.0
 * 
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *  under the License.
 */

package org.opu.odg.dg;

import java.io.OutputStream;
import java.util.List;
import org.opu.odg.dg.logicbeans.Template;
import org.opu.odg.dg.xml.ContentMapping.ContentEntry;

/**
 *
 * @author yura
 */
public interface DocumentGeneraionService {

    void generateDocument(GenerationSettings settings, OutputStream out) 
            throws Exception;

    /**
     * Validate input data as a template archive and return list of incomming
     * contents and variables
     * The content names start with '#' and variables with '$'
     * 
     * Return value will be stored in input lists, so they are can't be null.
     */
    List<String> validate(Template template, List<String> globalVars,
            List<ContentEntry> mappedEntry) throws Exception;
}
